home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 February / Macworld (1998-02).dmg / Shareware World / Comms & Internet / ShadowBot 1.23 / Plugin Docs / Script Variables < prev    next >
Text File  |  1997-05-27  |  2KB  |  49 lines
  1. ShadowBotScripting Language, Version 1.1.2
  2. © John Bafford, 1996-1997
  3.  
  4. Script Variables
  5.  
  6. Below is a list of all variables that can be used in scripts. They are case sensitive.
  7.  
  8. $NICK      - replaced with the nick of the user joining the channel.
  9. $ACCESS    - replaced with the user's access level (if not on the bot, -1)
  10. $PROTLEVEL - replaced with the user's protection level (if not in the bot, -1)
  11. $DATEl     - current date (longdate - eg, Saturday, August 3, 1996, or your equivilant) 
  12. $DATE      - current date (shortdate - eg, 8/3/78, or your equivilant)
  13. $TIME      - current time, without seconds
  14. $TIMEs     - current time, with seconds
  15. $CC        - the command character
  16. $BOTNICK   - the bot's nick (as opposed to it's current nick)
  17. $CHANNEL   - the channel the plugin was called on.
  18. $NUMARGS   - the number of arguments returned after a call to @GETARGS. $NUMARGS is -1
  19.              before this point.
  20. $ARGL      - returns the argument list.
  21. $ARGx      - $ARG0 returns the command name used. After processing with @GETARGS, 
  22.              $ARGx, 1 < x < 10 returns the xth argument. If there is no xth argument,
  23.              $ARGx returns an empty string.
  24. $USERMASKx - returns the hostmask for the xth parameter (or an empty string, if no
  25.              matching nick could be found). $USERHOST0 returns a hostmask for the user who
  26.              activated the plugin.
  27. $USERHOSTx - returns the username and host of the xth parameter; for example, 
  28.              DShadow@dshadow.dorm.umd.edu. $USERHOST0 returns the userhost of the person who
  29.              activated the plugin. If the person isn't in memory, userhost returns an empty
  30.              string.
  31.  
  32. Variable Access
  33.  
  34.     ShadowBot allows plugins to define private variables for themsevles. The following syntax is used to access these variables. The trailing period is REQUIRED.
  35.  
  36.     $GLOBAL:variableName.
  37.  
  38.  
  39. Random Functions
  40.  
  41.     ShadowBot includes a random number generator, which can be used by plugins. The trailing period is REQUIRED.
  42.  
  43.     $RAND:int:x,y. - generates a random number between (and including) x and y
  44.     $RAND:nick.    - generates a random nick on the current channel.
  45.  
  46.  
  47. Special Cases
  48.  
  49.     The $ARGx and $USERHOSTx tags are scanned only in scripts; they are ignored in ONTEXT plugins.